Night Owl 9

home *** CD-ROM | disk | FTP | other *** search

/ Night Owl 9 / Night Owl CD-ROM (NOPV9) (Night Owl Publisher) (1993).ISO / 010a / super25n.zip / FUNCTION.DOC < prev next >

Wrap

Text File | 1993-01-05 | 123KB | 4,000 lines

┌───────────────────────────────┐ │ SuperLib 2.50 │ │ For Clipper S87 and 5.01 │ │ ------------------------- │ │ copyright 1990 │ │ Garry A Prefontaine │ └───────────────────────────────┘ --------------------------------------------------------------------- FUNCTION: ABORT() Pops up dialog box asking: Abort? Yes No Pops up dialog box asking: Abort? Yes No Returns <expL> .t. for Yes .f. for No Category Popup Syntax ABORT([expC],[expN1],[expN2],[expN3],[expN4]) Description Tests if escape key was pressed at last wait state. If escape key was pressed, pops up a dialog box asking [Abort] [Don't Abort] Returns .t. if [Abort], .f. if [Don't Abort] or .f. if last key not 27 (escape key). Options Box color is C_POPMENU or optionally [expC] Box dimensions are: 9,29,13,51 or optionally [expN1],[expN2],[expN3],[expN4] Examples INKEY(0) IF ABORT() && test for lastkey() = 27 exit ENDIF do while .t. @10,10 get answer read if abort("+GR/R",10,10,20,20) loop else exit endif enddo Warnings Uses MENU TO so may blow get stack if called in the middle of a read. File S_ABORT.PRG --------------------------------------------------------------------- FUNCTION: ADDSPACE() Pads string with spaces Pads string with spaces Returns <expC> String padded with spaces. Category String Syntax ADDSPACE(<expC>,<expN>) Description Pads right side of <expC> with <expN> spaces. Truncates string if <expN> is shorter than original string length. Examples ADDSPACE("GARRY",10) results in "GARRY " ADDSPACE("GARRY",3) results in "GAR" Notes: Of course in Clipper 5.01, the function PADR() does the same thing. File S_ADDSP.PRG --------------------------------------------------------------------- FUNCTION: AKOUNT() Counts exact matches of value in array Counts exact matches of value in array Returns Number of matches Category Array Syntax AKOUNT(<array>,<exp?>) Description Counts # of exact matches of <exp?> in <array>. <exp?> can be of any type. Examples AFIELDS(m->fields,m->types) ** count C fields nbrofchar = AKOUNT(m->types,"C") ** count N fields nbrofnum = AKOUNT(m->types,"N") ** count D fields nbrofdate = AKOUNT(m->types,"D") ** count L fields nbroflogic = AKOUNT(m->types,"L") ** count M fields nbrofmemos = AKOUNT(m->types,"M") File S_AKOUNT.PRG --------------------------------------------------------------------- FUNCTION: ALLBUT() Returns all but last x characters Returns all but last x characters Returns <expC> all but last <x> characters Category String Syntax ALLBUT(<expC>,<expN>) Description Returns all but the rightmost <expN> letters of <expC> Examples string = "SUPERFUNCTION" string = ALLBUT(string,8) (returns "SUPER") string = ALLBUT(string,1) (returns "SUPE") Notes Useful when you don't know the length of a string in order to take left(x) characters. File S_ALLBUT.PRG --------------------------------------------------------------------- FUNCTION: APPENDIT() Intelligent APPEND FROM replacement Intelligent APPEND FROM replacement Returns Nothing Category Metafunction Syntax APPENDIT() Description Allows appending records from a database of dissimiliar structures, allowing point-and-shoot selection of field to field import. Import All/Query matches/Tagged records. There are no parameters, but a database is required to be open. Examples USE CUSTOMER APPENDIT() Notes This can be painfully slow on a busy network File S_APPEND.PRG --------------------------------------------------------------------- FUNCTION: ARRANGE() Rearranges text in a string Rearranges text in a string Returns <expC> rearranged Category String Syntax ARRANGE(<expC>,<expN1>,<expN2>,<expN3>) Description Extracts text from <expC1> starting at <expN1> for a length of <expN2> and moves it to position <expN3>. Examples string = "SUPERFUNCTION" string = ARRANGE(string,6,8,1) (returns "FUNCTIONSUPER") Notes New position is position AFTER text is cut from original position File S_ARRANG.PRG --------------------------------------------------------------------- FUNCTION: BEGEND() Determines beginning or end of week,month or quarter Determines beginning or end of week,month or quarter Returns <expD> beginning or end of week,month,quarter of date Category Date Syntax BEGEND(<expD>,<expN1>,<expN2>,<expN3>) Description Returns date which is beginning (1) or end (0) <expN1> of week (1) ,month (2) ,or quarter (3) <expN2> in which input date falls <expD> Options If week, <expN3> is day of the week beginning or end of the week <expN1> falls on, with sunday being 1 and saturday being 7. Examples cdate = ctod("01/15/90") bow = BEGEND(cdate,1,1,1) && beg of week eow = BEGEND(cdate,0,1,7) && end of week bom = BEGEND(cdate,1,2) && beg of month eow = BEGEND(cdate,0,2) && end of month boq = BEGEND(cdate,1,3) && beg of quarter eoq = BEGEND(cdate,0,3) && end of quarter File S_BEGEND.PRG --------------------------------------------------------------------- FUNCTION: BLDARR() Builds an array from a delimited string Builds an array from a delimited string Returns Nothing Category Array Syntax BLDARR(<array>|<expC1>,<expN>,<expC2>) Description Fills in the elements of an existing array <expC1>|<array> with <expN> character values extracted from a delimited string <expC2> of the form "Garry:Wyn:Ralph:Ed". The colon [:] is the delimiter. Options The first parameter may be either an array OR the name of an array (to retain compatibility with an older version when I knew even less about parameters than I do now) Examples declare lunch[3] BLDARR(m->lunch,3,"Pizza:Chicken:Burgers") Notes Array must be declared prior to calling Of course, in Clipper 5.01 you can also use: myarray := {"Pizza","Chicken","Burgers"} File S_BLDAR.PRG --------------------------------------------------------------------- FUNCTION: BLDDBF() Create a DBF from a delimited string Create a DBF from a delimited string Returns <expL> based on success. Category DBF Syntax BLDDBF(<expC1>,<expC2>|<array>) Description Creates DBF file named <expC1> from delimited strings in <expC2>|<array>. Parameter 2 is either: 1. a Delimited string in the form "name,type,[size],[decimals]:name,type..." Fields delimited by colon, field elements delimited by commas 2. an array of delimited strings in the form "name,type,[size],[decimals]". One field per array element, field elements delimited by commas. Examples 1. Passing long delimited string BLDDBF('CUSTOMER','LNAME,C,15:FNAME,C,10: AGE,N,2:PROSPECT,L:') 2. Passing array of short delimited strings declare newdbf[4] newdbf[1]="LNAME,C,15" newdbf[2]="FNAME,C,10" newdbf[3]="AGE,N,2" newdbf[4]="PROSPECT,L" BLDDBF('CUSTOMER',M->newdbf) Notes BLDDBF() expects an unused area to work in, and will return .f. if it detects a DBF open in the current area. An overwrite will not be allowed. BLDDBF() uses Clipper's low level file functions to create the DBF file You could also use Clipper 5.01's DBCREATE() function. File S_BLDBF.PRG --------------------------------------------------------------------- FUNCTION: BLDNDX() Interactively create a new index Interactively create a new index Returns <expC> New index name less extension Category Metafunction Syntax BLDNDX([array1],[array2],[array3]) Description Allows point and shoot building of a new index. Options <array1> - an array of legal field names. If not passed, all fields in current DBF will be used. <array2> - an array of field descriptions. If not passed,field names in current DBF will be used. Pass both or neither of these arrays. NETWORK VERSION ONLY: <array3> - an array of currently open index files to be reopened on exit from bldndx() (up to 10) Examples BLDNDX() -- or -- declare ndxflds[4],ndxdesc[4],ndxopen[3] ndxflds[1]="LASTNAME" ndxflds[2]="FIRSTNAME" ndxflds[3]="CITY" ndxflds[4]="ZIP" ndxdesc[1]="Last Name" ndxdesc[2]="First Name" ndxdesc[3]="City" ndxdesc[4]="Zip Code" ndxopen[1] ="CUSTOMER" ndxopen[2] ="STATE" ndxopen[3] ="ZIPCODE" BLDNDX(m->ndxflds,m->ndxdesc,m->ndxopen) Notes All fields are converted to type Character. The function NBR2STR() is used to create a usable character expression from a numeric field by first adding 1,000,000 to the number. BLDNDX() does not display a progress bar in the NETWORK VERSION Warnings Indexes created with this function will require the functions DTOS() and NBR2STR() be loaded prior to use if a date or numeric field is part of the index. File S_BLDNDX.PRG --------------------------------------------------------------------- FUNCTION: BOM() Calculates beginning of the month date Calculates beginning of the month date Returns <expD> beginning of the month Category Date Syntax BOM(<expD>) Description Calculates beginning of the month from <expD> Examples adate = ctod("10/15/90") bom = BOM(adate) (returns 10/01/90) Notes Written by Greg Pumroy and Ross Poppel and used with their permission File S_BOM.PRG --------------------------------------------------------------------- FUNCTION: BOYEAR() Determine beginning of year a date falls in Determine beginning of year a date falls in Returns <expD> date of the beginning of the year Category Date Syntax <expD> = BOYEAR([expD]) Description Determines beginning of the year of a date and returns it as <expD>. Options [expD] a date variable. Default is DATE() Examples begyear = BOYEAR(date()) File S_BOYEAR.PRG --------------------------------------------------------------------- FUNCTION: BUILDEX() Interactively builds and returns an expression Interactively builds and returns an expression Returns <expC> an expression string Category Conversion Syntax <expC>=BUILDEX(<expC>,<expC>,<expL>,<array1..2>) Description Interactively builds and returns an expression. (expression is in character string format) Pass parameters of <expC1> - a descriptive name for the expression, <expC2> an existing expression (field,etc.), <expL> allow TYPE change by BUILDEX() Options Pass all or none of the following arrays <Array1> Field name array <Array2> Field description array Examples express =; buildex("Indexexpression",COMPANY,.F.) File S_BUILD.PRG --------------------------------------------------------------------- FUNCTION: CENTR() Centers a string in x spaces Centers a string in x spaces Returns <expC> string centered Category String Syntax CENTR(<expC>,[expN]) Description Centers <expC> in <expN> spaces Options <expN> spaces is optional. Default is current string length Examples string = "Superfunction " string = CENTR(string,20) (returns " Superfunction " Notes In Clipper 5.01, use PADC(), which does the same thing and faster. File S_CENTR.PRG --------------------------------------------------------------------- FUNCTION: CLABEL() Menu driven module for label management Menu driven module for label management Returns nothing Category Metafunction Syntax CLABEL([array1..3]) Description This function requires no parameters and is entirely menu driven. Clipper compatible LBL files are created and maintained. Labels may be printed by Query matches, by Tagging, or all records. All Clipper formats are supported. Options Three arrays may be passed - array 1 is an array of allowable field names. Array two is an array of field descriptions. Array 3 is an array of field types. All three must be passed, or none. All fields are used as default, with field names being the default field descriptions. Examples use CUSTOMER CLABEL() or USE CUSTOMER private flds[3],fdes[3],ftyp[3] flds[1] = "fname" flds[2] = "lname" flds[3] = "mi" fdes[1] = "First Name" fdes[2] = "Last Name" fdes[3] = "Middle Initial" ftyp[1] = "C" ftyp[2] = "C" ftyp[3] = "C" CLABEL(flds,fdes,ftyp) Notes Requires datafile to be open. Creates and modifies Clipper compatible LBL files. Does not call LABEL FORM - (which pulls in 18K ) instead, uses its own label printing routine. Label printing routine compresses blank lines (i.e. a 2nd address), as well as removing all but single space in a line (i.e. FIRSTNAME+LASTNAME) File S_CLAB.PRG --------------------------------------------------------------------- FUNCTION: CLS() Clear the screen with optional color,character Clear the screen with optional color,character Returns Nothing Category Screen Syntax CLS([expN],[expC]) Description Clear the screen. Options Optional color [expN] and character [expC]. Examples CLS() && clears screen with current color CLS(48) && clears screen with black on cyan CLS(8,chr(177)) && clears screen grey on black && with character 177 Notes Of course in Clipper 5.01 you can also do: dispbox(0,0,24,79,repl(chr(177),9),"+N/N") and get the same result. File S_CLS.PRG --------------------------------------------------------------------- FUNCTION: COLPIK() Allows selection of colors from a list Allows selection of colors from a list Returns Nothing Category Screen Syntax COLPIK() Description Gives the user a choice of 12 pre-defined color combinations to choose from Examples COLPIK() SETCOLOR(M->c_normcol) Notes Color combo is stored to COLORS.MEM, but is not initialized until you issue a SETCOLOR() See INITSUP() for notes on using an alternate .mem file name (instead of COLORS.MEM) See appendix for more info on colors usage by the library. File S_COLPIK.PRG --------------------------------------------------------------------- FUNCTION: COPYITOUT() Copies records to a new DBF Copies records to a new DBF Returns nothing Category Metafunction Syntax COPYITOUT() Description Copies records to a new DBF, with query and tagging options. Examples Use (dbf_file) COPYITOUT() File S_COPY.PRG --------------------------------------------------------------------- FUNCTION: CRUNCH() Moves spaces in a string to end of string Moves spaces in a string to end of string Returns <expC> string with spaces moved to end Category String Syntax CRUNCH(<expC>,<expN>) Description Moves spaces to end of string <expC> <expN> if 1 moves all but single spaces to left of string. If 0 moves all spaces to end. Examples string = "SUPER Library version 1.50" string = CRUNCH(string,1) (returns "SUPER Library version 1.50 " string = CRUNCH(string,0) (returns "SUPERLibraryversion1.50 " Notes Handy for names (i.e. FIRST and LAST) File S_CRUNCH.PRG --------------------------------------------------------------------- FUNCTION: CTRLW() Sends chr(23) (Control-W) to the keyboard Sends chr(23) (Control-W) to the keyboard Returns Nothing Category Keyboard Syntax SET KEY XXX to CTRLW Description Allows remapping a key to Ctrl-W - a common Clipper EXIT key. CTRL-W is not a really intuitive key, but is often required by Clipper. I'll often set F10 to act as Ctrl-W. Examples EXTERNAL CTRLW SET KEY 27 to CTRLW && remaps ESCAPE to CTRL-W Notes Declare as EXTERNAL i.e. EXTERNAL CTRLW File S_CTRLW.PRG --------------------------------------------------------------------- FUNCTION: DATECALC() Adds/subtracts days,weeks,months,years to a date Adds/subtracts days,weeks,months,years to a date Returns <expD> new date Category Date Syntax DATECALC(<expD>),<expN>,<expN>) Description <expN1> is the number of units to add or subtract. If negative, subtraction takes place. <expN2> is the type of unit, where 1=days ,2=wks, 3=mnths, 4=yrs <expD> is the target date, to which units are added or subtracted. Examples adate = ctod("10/15/89") ** subtract 5 days less5days = DATECALC(adate,-5,1) ** subtract 5 weeks less5weeks = DATECALC(adate,-5,2) ** add 5 months add5months = DATECALC(adate,5,3) ** add 5 years add5years = DATECALC(adate,5,4) Notes Month adding/subtracting where the day of current month is greater than the # of days in the target month is done by using the # of days in the target month. i.e. 01/31/90 + 1 month = 02/28/90 If the input date is Feb 29th of a leap year, it is adjusted to Feb 28th before month or year calculations. My thanks to Greg Pumroy and ross Poppel for input File S_DATCAL.PRG --------------------------------------------------------------------- FUNCTION: DAYSIN() Calculates number of days in a month Calculates number of days in a month Returns <expN> days in month of date Category Date Syntax DAYSIN(<expD>) Description Returns # of days in month <expD> Examples adate = ctod("10/15/89") dimonth= DAYSIN(adate) (returns 31) Notes Leap year handling contributed by Ross Poppel File S_DAYSIN.PRG --------------------------------------------------------------------- FUNCTION: DELARRAY() Deletes all elements of an array Deletes all elements of an array Returns Nothing Category Array Syntax DELARRAY(<array>) Description Deletes all elements of an array. Basically un-initializes the array. Examples * Say you wish to re-use an array, passing * it to ACHOICE() each time around, and it * may have different lengths each time. What * you want to do is get rid of any extra * elements before re-filling the array. * e.g. declare reuse[200] * DO WHILE .t. * (code to pick and open dbf) * (code to pick and open dbf) afields(m->reuse) fieldpick = achoice(10,10,20,40,m->reuse) * (do something with field selected) * (do something with field selected) DELARRAY(m->reuse) ENDDO Notes In 5.01 you can do afill(array,NIL) instead File S_DELAR.PRG --------------------------------------------------------------------- FUNCTION: DELREC() Dialog box to delete/undelete current record Dialog box to delete/undelete current record Returns <expN> If deleted 1, if undeleted-1, if no action 0 Category Popup Syntax DELREC() Description Asks for delete/undelete record with menu prompt and then deletes/undeletes or not If current record is not deleted, prompt will be DELETE NOACTION If current record is deleted, prompt will be UNDELETE NOACTION Examples IF m->choice = 6 delcount = DELREC() ENDIF File S_DELET.PRG --------------------------------------------------------------------- FUNCTION: DOYEAR() Calculates day of the year from date Calculates day of the year from date Returns <expN> day of the year of date Category Date Syntax DOYEAR(<expD>) Description Calculates day of the year from <expD> Examples adate = ctod("10/15/90") dom = DOYEAR(adate) (returns 288) File S_DOYEAR.PRG --------------------------------------------------------------------- FUNCTION: DTDIFF() Returns difference between dates Returns difference between dates Returns <expN> days,weeks,months or years between dates Category Date Syntax DTDIFF(<expD>,<expD>,<expN>) Description Calculates difference between <expD1> and <expD2> in quantity defined by <expN> as: 1=whole days 2=whole weeks 3=whole months 4=whole years Examples adate = ctod("10/15/89") adate2= ctod("10/26/89") diffdays = DTDIFF(adate,adate2,1) diffweeks= DTDIFF(adate,adate2,2) diffmonth= DTDIFF(adate,adate2,3) diffyears= DTDIFF(adate,adate2,4) File S_DTDIFF.PRG --------------------------------------------------------------------- FUNCTION: DTOW() Converts date to words Converts date to words Returns <expC> date as words Category Date Syntax DTOW(<expD>) Description Returns date as words Examples adate = ctod("10/15/89") wdate = DTOW(adate) returns "October 15, 1989" File S_DTOW.PRG --------------------------------------------------------------------- FUNCTION: DUPLOOK() Locates possible duplicates based on user criteria Locates possible duplicates based on user criteria Returns nothing Category Metafunction Syntax DUPLOOK([expC],[array]) Description Searches current dbf for exact duplicates of field(s) selected by user. User picks a field or fields, DUPLOOK() creates an index and prepares a possible duplicates report. Options <expC> Character expression as additional info for each report line printed. (report normally only refers to record# and the fields selected ) <array> - an array of currently open index files to be reopened on exit from duplook() (up to 10) Examples private ndxopen[3] ndxopen[1] ="CUSTOMER" ndxopen[2] ="STATE" ndxopen[3] ="ZIPCODE" DUPLOOK("Lastname+' '+Firstname",m->ndxopen) * the fields the user picks to check duplicates * on,the LASTNAME and FIRSTNAME fields are also * printed on the report. Sample Output: Record # FNAME 1 GARRY 2 GARRY Warnings THIS FUNCTION CLOSES ANY OPEN INDEXES. YOU WILL NEED TO RE-OPEN INDEXES ON EXIT. (UNLESS YOU PASS AN ARRAY OF OPEN INDEXES AS ABOVE...) File S_DUP.PRG --------------------------------------------------------------------- FUNCTION: EDITDB() Customized DBEDIT() with UDF Customized DBEDIT() with UDF Returns nothing Category Metafunction Syntax EDITDB([expL1],[expN],[array],[array],[expL2]) Description Customized DBEDIT() interface allowing searching, goto, vertical view and (if <expL1> is True) add edit delete. Also allows limiting of fields viewed. Options [expL] allows add-edit-delete or not. Number of fields is contained in [expN]. The two arrays are of field names and field descriptions. Default is all fields, field names as descriptions. [expL2] allows bypass of the "BROWSE ALL/SELECT FIELDS" opening menu choice, and defaults to .f. Examples USE CUSTOMER private flds[3],fdes[3] flds[1] = "fname" flds[2] = "lname" flds[3] = "mi" fdes[1] = "First Name" fdes[2] = "Last Name" fdes[3] = "Middle Initial" editdb(.t.,3,flds,fdes) ... or ... USE CUSTOMER editdb() ... Notes Allows record deletion, but does not pack. Does not 'SET DELETED' one way or the other. File S_EDIT.PRG --------------------------------------------------------------------- FUNCTION: EDITMEMO() Performs a windowed memoedit() on a memo field Performs a windowed memoedit() on a memo field Returns nothing Category Popup Syntax EDITMEMO([expC],[expN1..N4],[expL],[expN5]) Description Pops up a box allowing editing of a memo field. Escape exits, F10 saves. Options Edits field named MEMO by default, otherwise fieldname passed as [expC]. Uses coordinates 2,10,20,69 unless passed coordinates as [expN1..expn4] (top,left,bottom,right) [expL] - .t. allow edit (default), .f. view only [expN5] - line length - default is window width-1 Examples editmemo() editmemo("NOTES") editmemo("NOTES",2,2,22,78) editmemo("NOTES",2,2,22,78,.f.) Notes If editing, must have a box width of at least 50 Requires a memo FIELD - will not work on a memvar. File S_EDITM.PRG --------------------------------------------------------------------- FUNCTION: ED_G_PIC() Returns appropriate picture for a get Returns appropriate picture for a get Returns <expC> picture clause Category Editing Syntax ED_G_PIC(<expC>) Description Returns a picture clause appropriate for editing field where <expC> is the name of the field. Applicable to Character and numeric fields Examples @10,10 GET AMOUNT PICT ED_G_PIC("AMOUNT") * would return a picture of "9999.99" depending * on length and decimals File S_EDPICT.PRG --------------------------------------------------------------------- FUNCTION: ENDSWITH() Determines if a string ends with another string Determines if a string ends with another string Returns <expL> Category Logical Syntax ENDSWITH(<expC>,<expC) Description Determines if string 1 <expC1> ends with string 2 <expC2> Examples str1 = "SUPERFUNCTION" str2 = "FUNCTION" str3 = "FUNKY" ENDSWITH(str1,str2) returns .t. ENDSWITH(str1,str3) returns .f. File S_ENDSW.PRG --------------------------------------------------------------------- FUNCTION: ENHANCED() Returns color integer for ENHANCED setting Returns color integer for ENHANCED setting Returns <expN> color integer for ENHANCED setting Category Screen Syntax enh = ENHANCED() Description Gets the 2nd part of the color string and converts it to color INTEGER Examples enh = ENHANCED() ATT(10,10,10,20,m->enh) Notes See appendix for more info on Super.Lib color usage File S_ENHAN.PRG --------------------------------------------------------------------- FUNCTION: EVALQ() Evaluates a logical condition Evaluates a logical condition Returns Logical Category Evaluation Syntax if evalq(<expC>) Description Macro expands <expC> and returns logical result Examples locate for evalq(query_exp) Notes In Clipper 5.01, you're better off doing queryblock := &("{||"+query_exp+"}") locate for eval(queryblock) File S_EVALQ.PRG --------------------------------------------------------------------- FUNCTION: FASTFORM() Prints a selected formletter for current record Prints a selected formletter for current record Returns nothing Category Metafunction Syntax FASTFORM() Description Presents a picklist of formletters to print against contents of current record. Examples If m->choice = 4 && form letter FASTFORM() endif Notes Utilizes a form created by FORMLETR() and plugs in values from the current record. Interface is a picklist of forms available. Depends on the current DBF to match the field values in the form. File S_FFORM.PRG --------------------------------------------------------------------- FUNCTION: FILEINFO() Returns file date,time,size Returns file date,time,size Returns Returns file date,time,size Category File Syntax FILEINFO(<expC>,<expN>) Description Returns info on file in <expC> based on param passed 1 - returns file size (numeric) 2 - returns file date (date) 3 - returns file time (character) Examples filesize = fileinfo("customer.dbf",1) Warnings Will bomb if the file does not exist. Check for FILE() before calling File S_FILEIN.PRG --------------------------------------------------------------------- FUNCTION: FILEREAD() Lists a text file of unlimited size Lists a text file of unlimited size Returns nothing Category Metafunction Syntax FILEREAD([expN1],[expN2],[expN3],[expN4],[expC]) Description Lists text file [expC] of unlimited size in a user definable window. [expN1..expN4]. Allows up down right left scrolling. Use this for reports or output sent to a disk file. Options If [expN1..expN4] are not passed, a default of window of dimensions 2,2,22,78 is used. If no filename [expC] is passed, a popup picklist is used to get a file name from the current directory. Examples REPORT FORM summary TO summary.txt FILEREAD(2,2,22,78,"SUMMARY.TXT") Notes Unlimited file size. Won't bomb like memoedit. However, not nearly as fast as memoedit and no editing capabilities. Fileread uses a 98% Clipper code routine to list text files. Fileread() will use SET DEFAULT if no path is specified. (NETWORK) File S_FILER.PRG --------------------------------------------------------------------- FUNCTION: FILLARR() Fill type, length, decimal arrays Fill type, length, decimal arrays Returns Nothing Category Array Syntax FILLARR(<array1>,<array2>,[array3],[array4]) Description Fills in TYPE, LENGTH and DECIMAL arrays (array2-4) given a FIELDNAME array (array1) Options Arrays (3 and 4) are optional. Examples number_of_flds = ALENG(m->fnames) declare fldtypes[number_of_flds] declare fldlens[number_of_flds] declare flddec[number_of_flds] FILLAR(fnames,fldtypes,fldlens,flddec) Notes In most circumstances you would fill all of these arrays with one call to AFIELDS(), but there are exceptions. Warnings Macro expands an expression to obtain type-could crash if expression passed is invalid. File S_FILLAR.PRG --------------------------------------------------------------------- FUNCTION: FORMLETR() Interactive formletter and mailmerge utility Interactive formletter and mailmerge utility Returns nothing Category Metafunction Syntax FORMLETTER([array1..array3][array4..array6]) Description Provides a menu driven interface to the creation, modification and merging of form letters with DBFs. Options Three field arrays may be passed - array 1 is an array of allowable field names. Array 2 is an array of field descriptions. Array 3 is an array of field types. All fields are used as a default, with field names being the default field descriptions. Three additional arrays may be passed for up to 30 additional hotkeys. Array 4 is an array of functions which will be placed between «» delimiters. Array 5 is a corresponding descriptive array of these functions, to be shown when the user presses F1. Format: "hotkey description " | column 1 | column 17 Array 6 is the corresponding hotkeys as their numeric ascii values. All three arrays must be passed, if any, and all must be of same length with no null or undefined elements. You could use these for Printer control, special combined fields, etc. Be sure the functions you wish to call are available to the linker, usually by declaring them EXTERNAL. Examples USE CUSTOMER private flds[3],fdes[3],ftype[3] PRIVATE U_EX[3],U_DE[3],U_KY[3] * field descriptions flds[1] = "fname" flds[2] = "lname" flds[3] = "mi" fdes[1] = "First Name" fdes[2] = "Last Name" fdes[3] = "Middle Initial" ftype[1]="C" ftype[2]="C" ftype[3]="C" * hotkey arrays * 1 - EXPRESSIONS - BE SURE THESE ARE DECLARED EXTERN * (note: these are not actual functions in *the library - just examples of what you could *do) U_EX[1]= "BOLD_ON()" && returns printer control for U_EX[3]= "BOLD_OFF()" && bold on/off U_EX[2]= "DEARPHRASE()" && returns "Dear &&<name>" * 2 - DESCRIPTIONS FOR HELP SCREEN U_DE[1]= "F5 BOLD PRINT ON" U_DE[2]= "F6 BOLD PRINT OFF" U_DE[3]= "F7 INSERT DEAR <first> <last>" * 3 - KEY VALUES for hotkeys U_KY[1]= -4 U_KY[2]= -5 U_KY[3]= -6 FORMLETR(flds,fdes,ftype,u_ex,u_de,u_ky) ... ....or.... USE CUSTOMER FORMLETR() ... Notes Structure for database : FORM.DBF Field Field Name Type Width Dec . 1 DESCRIPT Character 50 . 2 MEMO_ORIG Memo 10 See INITSUP() for notes on using a different file name for FORM.DBF File S_FORML.PRG --------------------------------------------------------------------- FUNCTION: FREQANAL() Performs a frequency analysis on a DBF Performs a frequency analysis on a DBF Returns nothing Category Metafunction Syntax FREQANAL() Description Performs a point&shoot frequency analysis on selected fields of the DBF. Allows for tallying of additional numeric fields. Examples USE (dbf_file) FREQANAL() File S_FREQ.PRG --------------------------------------------------------------------- FUNCTION: FULLDIR() Interactively navigate directories Interactively navigate directories Returns <expL> Directory was selected Category Metafunction Syntax FULLDIR([expL],[@expC]) Description Interactively navigates directories on the current drive. Allows pop-up list of files in a directory. Allows reading of a file ( with FILEREAD() ) in a directory. If file is DBF, does a DBEDIT browse (watch your memory..) Options [expL] True - change to selected directory False - don't change to selected directory Default is True - change [@expC] Char string passed by reference, will contain name of selected directory on return. Examples NEWDIR = "" if FULLDIR(.F.,@NEWDIR) SET DEFAULT TO (NEWDIR) ?"New directory is:" ?Curdir() endif File S_FULLD.PRG --------------------------------------------------------------------- FUNCTION: GENED() Generic dbf editing screen Generic dbf editing screen Returns nothing Category Metafunction Syntax GENED([expL],[expN1],[expN2],[array1],[array2]) Description Edit ( [expL]=.f.) current record or Add ( [expL]=.t.) new record. Options Window top [expN1] and bottom [expN2] default to centered. Use optional [array1] (field names) and [array2] (field descriptions), or use all fields in dbf. Examples use Customer index Customer Gened(.f.,2,20) && edit ... or use Customer index Customer Gened(.t.,3,15) && add ... or use Customer index Customer Gened() && edit ... Notes Allows memo editing (multiple memo fields) File S_GENED.PRG --------------------------------------------------------------------- FUNCTION: GENVAL() Generic VALID clause validation with message Generic VALID clause validation with message Returns <expL> logical result of passed condition Category Editing Syntax GENVAL(<expC1>,<expC2>) Description Evaluates macro expansion of <expC1> as a logical value. If result is False, displays message <expC2> and waits for a keypress. Examples if genval("fcount() < 60",'Too many fields') COPY TO TEMP endif * ...or as a VALID CLAUSE @10,10 get m->lname VALID ; GENVAL("!empty(lname)","Need a last name") File S_GENVA.PRG --------------------------------------------------------------------- FUNCTION: GETAKEY() Gets intent of last keystroke Gets intent of last keystroke Returns <expC> as key direction (FWD,BWD,ESC,CTW,UNK) Category Editing Syntax GETAKEY(lastkey()) Description Gives key direction of last key, for evaluating what direction in a read the user is heading. Examples If GETAKEY(LASTKEY())="FWD" active_field = active_field+1 elseif GETAKEY(LASTKEY())="BWD" active_field = active_field-1 endif File S_GETKEY.PRG --------------------------------------------------------------------- FUNCTION: GETCALC() Pops up a quick 'solar' calculator Pops up a quick 'solar' calculator Returns <expN>/<expC> total from calculator Category Popup Syntax GETCALC([expN],[expL]) Description Pop up 'solar' calculator for simple arithmetic Options [expN] starting number [expL] return as character string (default .t.) Examples GETCALC(5) Notes Written by ROSS S. POPPEL and GREGORY W. PUMROY (of the Philidelphia Clipper Users Group.) File S_GETCAL.PRG --------------------------------------------------------------------- FUNCTION: GETDATE() Point and shoot calendar Point and shoot calendar Returns <expD> date selected Category Popup Syntax GETDATE([expD]) Description Allows user to point to and select a date Options [expD] optional date parameter to start with. If no date passed, system date is used. Examples set key -1 to GETDATE Notes Written by Ross Poppel / Greg Pumroy File S_GETDAT.PRG --------------------------------------------------------------------- FUNCTION: GETDFP() Gets SET DEFAULT path Gets SET DEFAULT path Returns SET DEFAULT path as string Category Environment Syntax GETDFP() Description Retrieves and returns SET DEFAULT path from Clipper. Appends a "\" if needed. If no SET DEFAULT is active, returns an empty string "" Examples ERASE (getdfp()+tempfile) Notes Calls SET(). This is a built in Clipper 5.0 function, for which a semi-replacement has been provided for S87. The S87 version accesses S87 internals, but these are not likely to change anymore <grin>. File S_GETDFP.PRG --------------------------------------------------------------------- FUNCTION: GLOBREP() Performs global selective replace of a field Performs global selective replace of a field Returns nothing Category Metafunction Syntax GLOBREP() Description Allows user to point to a field and then enter a replacement value for it. Replacement can be executed for all records, query matches, or tagged records. Examples If choice = 9 && Global replace GLOBREP() endif Warnings These changes are, of course, permanent. File S_GLOBR.PRG --------------------------------------------------------------------- FUNCTION: HELP() Provides context sensitive popup help Provides context sensitive popup help Returns nothing Category Help Syntax SET KEY xxx TO HELP Description By setting a key xxx to this function, the current PROC and VARIABLE are passed to it when the key is pressed during the program. By comparing the PROC and VARIABLE parameters against entries in the HELP.DBF, HELP() can then provide the appropriate help screen for the user. If no matching record is found, HELP() displays a 'No Help Found' message to the user. HELP() works in conjunction with HELPMOD() which is used to create help screen records for the HELP.DBF. HELPMOD() allows online creation and modification of the size, location and contents of the help screen for the current PROC,VARIABLE combination. It is important to issue the following statement in your code: EXTERNAL HELP Examples EXTERNAL HELP SET KEY 28 to HELP Notes Will not be much use during ACHOICE or MENU TO Warnings The SET KEY that called this proc is still active inside the proc. You may wish to modify the proc to turn off/on the set key. i.e. if called with key 28 (F1) at start : SET KEY 28 to at end: SET KEY 28 to HELP File S_HELP.PRG --------------------------------------------------------------------- FUNCTION: HELPMOD() Interactively build and modify help screens Interactively build and modify help screens Returns nothing Category Development Syntax SET KEY xxx TO HELPMOD Description HELPMOD() creates and modifies help screens for HELP() which are stored in HELP.DBF. HELPMOD() allows online creation and modification of the size, location and contents of the help screen for the current PROC,VARIABLE combination, and stores the results in HELP.DBF. HELPMOD() is intended to be used online, during program execution, by the developer/programmer. It can be removed after development. By setting a key xxx to this function, the current PROC and VARIABLE are passed to it when the key is pressed during the program. By comparing the PROC and VARIABLE parameters against entries in the HELP.DBF, HELPMOD() can then provide the appropriate help screen for modification, or, if no matching record is found, allow creation of a new help screen record. It is important to issue the following statement in your code: EXTERNAL HELPMOD This is due to Clipper not recognizing and linking in procs that are only referenced as SET KEY's. HELP.DBF is created if not present. Examples EXTERNAL HELPMOD SET KEY -30 TO HELPMOD && alt-F1 Notes Will not be much use during ACHOICE or MENU TO File S_HELPM.PRG --------------------------------------------------------------------- FUNCTION: INITSUP() *** Initializes global variables and conditions Initializes global variables and conditions Returns Nothing Category Environment Syntax INITSUP() Description The first time INITSUP() is called, it simply initializes the global variables expected by Super.Lib functions if they are not already present. On subsequent calls, INITSUP() does nothing. QUERY_EXP is set to "". This is the global variable used to store the last query built with QUERY(), and is accesses by many Super.Lib functions. _SUPERPRN is set to "LPT1". This is the default printer for Super.Lib output. _CHECKPRN is initialized to .T. This variable tells P_READY() whether or not it should attempt to check the printer status. On a redirected printer on a LAN this should be set to .F., as ISPRN() will not work. INITSUP() will look for a variable called _SUPISCOLOR. If it is present and of type "L", its value will be used in place of ISCOLOR(). You may want to initialize a public variable _SUPISCOLOR if you have one of those card/monitor combos that fool ISCOLOR(). Advanced INITSUP() settings: System files (used by Super.Lib) all have default names which may be overridden. The defaults are contained in a set of public variables. They are: _REPORTS = "SFREPORT" (for reports) _FORMS = "FORM" (for form letters) _QUERIES = "QUERIES" (for queries) _LISTER = "PLIST" (for lister) _TODODBF = "TODO" (for todo list) _TODONTX1 = "TODO" (TODO category INDEX) _TODONTX2 = "TODOP" (TODO priority INDEX) _TODONTX3 = "TODOD" (TODO do by INDEX) _HELP = "HELP" (for help) _SCROLLER = "SCROLLER" (for scroller) _COLORS = "COLORS" (for colors) to override a system file name, set the variable name to a name of your choice BEFORE the first call to INITSUP(). Do not use an extension. Examples * beginning of top level program _REPORTS = "C:\AMY\REPORTS" _QUERIES = "C:\AMY\QUERIES" INITSUP() _SUPERPRN = "LPT2" Notes Its always a good idea to call this at your top level program. All of the superfunctions doing screen i/o call it. It initializes the global variable _SUPERFUNC the first time it is called. Thereafter, the initialization routines are not called if _SUPERFUNC exists. (see the opening IF statement) File S_INIT.PRG --------------------------------------------------------------------- FUNCTION: ISLOADED() Determines function is loaded or not Determines function is loaded or not Returns <expL> is ISLOADED(<expC>) loaded Category Environment Syntax <expL> = ISLOADED(<expC>) Description This function will test for <expC> being loaded into memory. <expC> can be any function in the form "FUNCTION()" but must refer to a function NOT in CLIPPER.LIB. Examples if ISLOADED("QUERY()") @row()+1,3 prompt "Build Query" endif File S_ISLOAD.PRG --------------------------------------------------------------------- FUNCTION: ISPART() Determines if a number is part of a set Determines if a number is part of a set Returns <expL> if number is part of set Category Logical Syntax ISPART(<expN1>,<expN2>,<expN3>,...<expN10>) Description Compares a number <expN1> to a set of numbers <expN2..expN10> to determine if it is equal to any of them. Returns True if it is, False otherwise. Options Up to 9 numbers to compare. Examples If ISPART(choice,5,6,7,12) MSG("Need a DBF open") loop endif File S_ISPART.PRG --------------------------------------------------------------------- FUNCTION: KBDESC() Keyboards character 27 (escape) when key pressed Keyboards character 27 (escape) when key pressed Returns nothing Category Keyboard Syntax SET KEY xxx TO KBDESC Description Allows setting an alternate key to the ESCAPE key. ESCAPE normally means 'get me outta here', but sometimes is the key you need to indicate the user is done selecting or some such. This function allows setting another key (e.g. F10) to act as the ESCAPE key. Examples SET KEY -9 TO KBDESC Notes Declare as EXTERNAL i.e. EXTERNAL KBDESC Warnings Be sure to issue a SET KEY xxx TO command to un-map this function when done File S_KBDESC.PRG --------------------------------------------------------------------- FUNCTION: LISTER() Build, format,print lists to printer,screen,file Build, format,print lists to printer,screen,file Returns nothing Category Metafunction Syntax LISTER([array1],[array2]) Description A menu driven utility for creation, printing and storage of list definitions. The user is asked to pick the fields to be included on the list. The selected fields, in the order in which they will be listed, are shown in the bottom information box. The user may select which records are to be included in the list - all records, query matches or tagged records. The user may select output as PRINTER, SCREEN or FILE, and choose the maximum line length to avoid printer wraparound. The user may save list definitions to PLIST.DBF and later restore them. Options Two arrays may be passed - fieldnames [array1], field descriptions [array2] Pass both or none. Normally, field names are used as the column headings for the list, but if [array2] is passed, these descriptions are used in the column headings of corresponding fields. By default, all fields are used, field names are used for descriptions. Examples USE CUSTOMER private flds[3],fdes[3] afields(m->flds) fdes[1] = "First Name" fdes[2] = "Last Name" fdes[3] = "Middle Initial" LISTER(flds,fdes) ... or ... USE CUSTOMER LISTER() Notes Structure for database : PLIST.DBF Field Field Name Type Width Dec . 1 DESC Character 45 . 2 LIST Character 200 ** Total ** 246 File S_LIST.PRG --------------------------------------------------------------------- FUNCTION: LJUST() Left justifies a string Left justifies a string Returns <expC> string left justified Category String Syntax LJUST(<expC>) Description Left justifies <expC> Examples string = " Superfunction" string = LJUST(string) (returns "Superfunction " File S_LJUST.PRG --------------------------------------------------------------------- FUNCTION: MAKEBOX() Draws a shadow box on the screen, saves the screen Draws a shadow box on the screen, saves the screen Returns <expC> string containing underlying screen & colors Category Popup Syntax MAKEBOX(<expN1>,<expN2>,<expN3>,<expN4>,[expC],[expN5]) Description Draws a box at screen coordinates <expN1..expN4> Returns a string containing the underlying screen and previous color. Box will explode or not based on the global variable C_XPLODE. Options Default color is setcolor(). Default shadow position is the global var [c_shadpos]. These may be passed as options . Shadow position [expN5] has allowable values of (1,3,7,9,0) to match the corner positions on the numeric keypad. 0 is no shadow. [expC] is a valid color string or variable. Examples box = MAKEBOX(5,5,10,10) *draws a box at 5,5,10,10. Color is SETCOLOR(). *shadow position is based on C_SHADPOS. box = MAKEBOX(5,5,10,10,C_POPCOL) *draws a box at 5,5,10,10. Color is C_POPCOL. *shadow position is based on C_SHADPOS. box = MAKEBOX(5,5,10,10,C_POPCOL,9) *draws a box at 5,5,10,10. Color is C_POPCOL. *shadow position is 9 (upper right hand corner) Notes UNBOX() removes the box and restores the underlying screen and prior colors. Warnings Use only UNBOX() to remove screens stored with MAKEBOX(). File S_MAKEB.PRG --------------------------------------------------------------------- FUNCTION: MCHOICE() Creates a box for an Achoice call Creates a box for an Achoice call Returns <expN> Achoice selection Category Popup Syntax MCHOICE(<expC1>|<array>,<expN1..4>,[expC2],[expL]) Description Provides a box for an achoice on array <expC1>/<array> of dimensions <expN1..expN4> (top,left,bott,right) Options Title <expC2> i.e. "Select One" <expL> determines (yes or no) whether a return is to be executed on a first letter match.(default .f.) Examples declare MEALS[3] meals[1]= "Pizza" meals[2]= "Chicken" meals[3]= "Chinese" * box only, no title selection = MCHOICE(m->meals,10,10,15,25) *or box with title selection = ; MCHOICE("meals",10,10,15,25,"Pick-a-Meal") *or box with title, first letter match = return selection = ; MCHOICE(meals,10,10,15,25,"PickaMeal",.f.) Notes Bottom of window adjusts (shrinks) to adjust to array size. File S_MCHOI.PRG --------------------------------------------------------------------- FUNCTION: MENU_V() Vertical popup menu from variable # parameters Vertical popup menu from variable # parameters Returns <expN> selection - 0 for no selection Category Menu Syntax MENU_V(<expC1>,<expC2>,<expC3>,...<expC16>) Description Creates a popup vertical menu in a centered box, using <expC1> as the title, and performing a menu to on <expC1...expC16> (variable #) <expC1> may be passed as "" for no title. Examples choice = ; menu_v("Selection","Edit","Add","Quit") -or- choice =menu_v("","Edit","Add","Quit") Warnings A MENU TO is performed which tends to blow active gets. Be careful if doing this during a READ. File S_MENUV.PRG --------------------------------------------------------------------- FUNCTION: MESSYN() Popup YesNo prompt box Popup YesNo prompt box Returns <expL> True for yes, False for No Category Popup Syntax MESSYN(<expC1>,[expN1],[expN2],[expC2],[expC3]) Description Pops up a box and displays a question <expC1> and two prompts. Options [expN1] and [expN2] are optional box top and left coordinates. Default is centered. [expC2] ,[expC3] are optional prompts 1 and 2. Default is YES/NO. The options can be given in any of the following arrangements: [expN1],[expN2],[expC2],[expC3] [expC2],[expC3],[expN1],[expN2] [expC2],[expC3] [expN1],[expN2] Examples if messyn("Are you done") if messyn("Are you done",10,10) if messyn("Are you done",10,10,"Not; yet","Almost") if messyn("Are you done","Not ; yet","Almost",10,10) if messyn("Are you done","Not ; Yet","Almost") File S_MESSYN.PRG --------------------------------------------------------------------- FUNCTION: MFIELDS() Pops up an achoice for current dbf fields Pops up an achoice for current dbf fields Returns <expC> field name or "" if none selected Category Popup Syntax <expC> = Mfields([expC],[expN1..expN4]) Description Popus up a box and presents an achoice() for the current dbf fields. Options [expC] title for box. [expN1..expN4] coordinates of the box. Default is centered. Examples fieldname = MFIELDS() *or fieldname = MFIELDS("Pick a Field") *or fieldname = MFIELDS('Pick a Field',10,10,20,40) File S_MFLD.PRG --------------------------------------------------------------------- FUNCTION: MODIFY() Create or modify DBF structures Create or modify DBF structures Returns <expC> name of datafile created/modified Category Metafunction Syntax MODIFY() Description dBase-like MODI STRU for creating/modifying DBFs. Examples MODIFY() Warnings NOT A NETWORK FUNCTION - DO NOT USE ON A NETWORK File S_MODIFY.PRG --------------------------------------------------------------------- FUNCTION: MSG() Displays up to a 9 line message in a window Displays up to a 9 line message in a window Returns Nothing Category Popup Syntax Up to 9 character strings as lines in the message . Description Displays in a popup box up to 9 lines of a message. Then waits for a keypress or optionally a time-out. Options First parameter can be a number equalling a time-out value in seconds Examples MSG("An error has been detected",; "...don't move!") MSG("A","B","C","D","E","F") MSG(5,"A","B","C","D","E","F") Notes Message is centered on screen in a box Once message is displayed, waits for keypress and then removes window, restoring screen underneath. Or waits for time-out value. File S_MSG.PRG --------------------------------------------------------------------- FUNCTION: NBR2STR() Correctly orders numerics where negative Correctly orders numerics where negative Returns String Category Conversion Syntax <expC> = NBR2STR(<expN>) Description Ensure numeric fields are correctly ordered when converting to type character and when taking negatives into account. This is done by attaching CR, DB or CZ to the end of the number to overcome the placement of (-+) in the ASCII scale. Examples index on LASTNAME+NBR2STR(amount_due) to ; NEWINDEX File S_NBR2ST.PRG --------------------------------------------------------------------- FUNCTION: NKEY() Gets key of an index file Gets key of an index file Returns <expC> index key expression Category File Syntax NKEY(<expC>) Description Gets key expression of index <expC>. <expC> is the name of the index including extension. The function operates differently from .ntx to .ndx. Examples ndxknt = adir("*.ndx") declare ind[ndxknt] adir(ind,"*.ndx") for i = 1 to ndxknt ?"Key for index: "+ind[i]+" is; "+NKEY(ind[i]) next Notes NKEY() expects the full path of the index file and if no path is passed, will use SET DEFAULT setting Warnings Uses up a file handle temporarily. File S_NKEY.PRG --------------------------------------------------------------------- FUNCTION: NOZDIV() Prevents divide-by-zero Prevents divide-by-zero Returns <expN> Category Conversion Syntax NOZDIV(<expN>) Description Prevents divide-by-zero by converting a number to 1 if it is zero, otherwise leaving it as-is. Examples x = 5 y = 0 z = x/NOZDIV(y) File S_NOZDIV.PRG --------------------------------------------------------------------- FUNCTION: ONE_READ() Pop-up window with 1-4 Say/Get combinations Pop-up window with 1-4 Say/Get combinations Returns nothing Category Popup Syntax ONE_READ(<expC1>,<expC2>,<expC3>,...) Description For 1-4 iterations of <expC1..expC3>, a popup window will display a Say <expC1>, do a Get on the variable named in <expC2> with a Picture of <expC3>. A read will then be issued. Examples c_date = date() c_time = space(8) fun = .t. ONE_READ("Current Date","C_DATE","@D",; "Current Time","C_TIME","99:99:99",; "Having Fun ?","FUN","Y") Notes What I've since realised is that <expC2> should actually be passed by reference (@). This would cut down on all the macro-expansionitis. ASSUMES GET VARIABLES HAVE BEEN INITIALIZED IN CALLING PROGRAM Mainly here for compatibility with older versions See POPREAD() for a better implementation. File S_ONER.PRG --------------------------------------------------------------------- FUNCTION: OPENIND() Opens an array of indexes Opens an array of indexes Returns Nothing Category DBF Syntax OPENIND(<array>) Description Opens up the indexes named in <array> Examples declare indx[3] indx[1] = "CUSTOMER" indx[2] = "PRODUCT" indx[3] = "PAYDATE" OPENIND(m->indx) File S_OPENIN.PRG --------------------------------------------------------------------- FUNCTION: P_READY() Determines if printer is ready, prompts user Determines if printer is ready, prompts user Returns <expL> True if printer is ready Category Popup Syntax if p_ready([expC]) Description Checks for printer ready, and prompts user to ready the printer until it is ready, or until user presses escape to abort printing. p_ready() first looks at _CHECKPRN, and if the value is .f., does no printer check and returns .t. Options [expc] - LPT1 LPT2 LPT3 Default is LPT1 Examples if P_READY("LPT2") REPORT FORM yayaya TO PRINT ENDIF Notes The variable _CHECKPRN is initalized as a PUBLIC to .T. by INITSUP(). If on a network and using redirected printers, set this to .F. after first call to INITSUP(). i.e. INITSUP() _CHECKPRN = .F. File S_PREAD.PRG --------------------------------------------------------------------- FUNCTION: PICKNDX() Allows user to select indexes to open Allows user to select indexes to open Returns # of indexes selected Category DBF Syntax PICKNDX(<expA>) Description Allows the user to point and shoot index selection. [expA] is an array to fill with index names, initialized to the max # of indexes to open Examples declare INDIES[10] nbrpicked = pickndx(indies) File S_PICKND.PRG --------------------------------------------------------------------- FUNCTION: PLSWAIT() Pops up a 'Please Wait' window or removes it Pops up a 'Please Wait' window or removes it Returns nothing Category Popup Syntax PLSWAIT(<expL>,[expC],[expN1..expN4]) Description Pops up a window with a 'please wait' message or removes a previous 'please wait' window. <expL> True = popup window. <expL> False means remove window. Options [expC] - message. Default is 'Please wait...' [expN1..expN4] box coordinates. Defaults are 10,20,12,60 (top,left,bottom,right) Examples PLSWAIT(.T.,"I'm thinking...") ...code... ...code... ...code... PLSWAIT(.F.) Notes Makes public the variables : pls_top,pls_left,pls_bot,pls_right,pl_wait And releases them when called with .f. File S_PLSW.PRG --------------------------------------------------------------------- FUNCTION: POPEX() Pops up an achoice for a certain filespec Pops up an achoice for a certain filespec Returns <expC> file name or "" for none If a path is specified, a path will also be returned. Category Popup Syntax <expC> = Popex(<expC>,[expC]) Description Pops up a picklist for all files matching the skeleton given as <expC>. i.e. "*.dbf" Options Optional title string - displays at top of box Examples opendbf = POPEX("*.DBF") => will return DBF name opendbf = POPEX("C:\FILES\*.DBF") => will return "C:\FILES\" plus DBF name File S_POPEX.PRG --------------------------------------------------------------------- FUNCTION: POPREAD() Pops up a box with 1-5 say-get combinations Pops up a box with 1-5 say-get combinations Returns nothing Category Popup Syntax POPREAD(<expL>,[expN1,expN2,expC1],; <expC1>,<@exp>,<expC2>,..) Description [expL] .t. = GETS are displayed below SAYS, .f. = GETS are displayed beside SAYS (default) [next 3 params may be option params - see below] For 1-5 iterations of <expC1..expC3>, a popup window will display a Say <expC1>, do a Get on the variable passed by reference in <@exp> with a Picture of <expC3>. A read will then be issued. Options If params 2,3 and 4 are passed as Numeric/Numeric/Chr then they are evaluated as the top,left and color for the popup box. [expN1] = top [expN2] = left [expC3] = color string Notes This is an intelligent version of ONE_READ. 2nd param is passed by reference rather than by name - cutting down DRASTICALLY on the macro expansion and greatly simplifying the code. To pass by reference, preface the parameter with @. Examples c_date = date() c_time = space(8) fun = .t. POPREAD(.t.,"Current Date",@C_DATE,"@D",; "Current Time",@C_TIME,"99:99:99",; "Having Fun ?",@FUN,"Y") File S_POPR.PRG --------------------------------------------------------------------- FUNCTION: PRNPORT() Determine Printer Port to use Determine Printer Port to use Returns <expC> port chosen Category Environment Syntax PRNPORT([expC1],[expC2]..[expC9]) Description Allows user to select printer port for SET PRINTER TO output. Printer is set to this port Options [expC1-9] are valid SET PRINTER TO strings LPT1 LPT2 LPT3 COM1 COM2 COM3 COM4 <FILENAME> Examples theport = PRNPORT("LPT1","COM1") File S_PRNPOR.PRG --------------------------------------------------------------------- FUNCTION: PRNTFRML() Prints a formletter created by formletr() Prints a formletter created by formletr() Returns nothing Category Other Syntax PRNTFRML(<expC>,<expN>) Description Prints the form <expC> from FORMS.DBF with a pagewidth of <expN>. Examples This is used internally by FORMLETR() and FASTFORM(). Refer to its usage there. File S_PRNTF.PRG --------------------------------------------------------------------- FUNCTION: PROPER() Capitalizes first letters of string, lowers rest Capitalizes first letters of string, lowers rest Returns <expC> string properized Category String Syntax PROPER(<expC>) Description Capitalizes all first letters of words in <expC> and converts the rest to lowercase Examples string = "SUPERFUNCTION library" string = PROPER(string) (returns "Superfunction Library" Notes There are cases where this just won't work - for instance I.B.M. would be converted to I.b.m. File S_PROPER.PRG --------------------------------------------------------------------- FUNCTION: PULLDN() Pulldown menu creator, handler Pulldown menu creator, handler Returns A number in the form menu.prompt (i.e. 2.04) Category Menu Syntax <expN> = PULLDN(<expN>,<array1>,[array2],[array3]) Description Draws a pulldown menu with up to 8 separate boxes. Selection process starts with <expN>. Each element of <array1> defines a menu. A menu definition is a delimited string in the form "TITLE:prompt:prompt:prompt" with up to 99 prompts per string. Options [array2] is a box definition array. It is 7 elements long and defines the following: Element: 1. <expL> Draw top bar box? T/F 2. <expC> Top bar color 3. <expC> Menu Box color 4. <expC> Menu Box frame 5. <expN> Menu Box shadow position (0,1,3,7,9) 6. <expN> Menu Box shadow attribute 7. <expN> Row to start menu bar [array3] is an array of title column positions to override the internal 'figerin algorithm. Examples declare box[6],bdata[7] box[1] = "Datafiles:Use Datafile" box[2] = "Indices:Select Indices:Index order" box[3] = "Editing:Replacement:Tabular Edit" box[4] = "Reporting:Build Query:Print Lists" box[5] = "Other:List file:Change Directory" box[6] = "Quit" sf_sel = 1.01 *- define menu boxes bdata[1]= .t. && draw the top bar box bdata[2]= 'W/B,GR/R,,,W/N' && top bar color bdata[3]= 'W/B,N/R,,,W/N' && drop box color bdata[4]= m->single_frame && drop box frame bdata[5]= 3 && drop box shadow position bdata[6]= 8 && drop box shadow attribute bdata[7]= 0 && row # of menu bar do while .t. sf_sel = PULLDN(sf_sel,box,bdata) do case CASE sf_sel = 0 && TRAP 0 sf_sel = 1.01 case sf_sel = 1 case sf_sel = 2 case sf_sel = 3 case sf_sel = 4 endcase enddo Notes First letter selection takes place on the following priority: next matching element first letter, next matching box title first letter. Passing a menu array element with title only will result in no menu box, with the title being the only selection and returning a selection value of <MENU>.1. (i.e. a 'Quit' box) Warnings It takes some work to start all options and titles with a first letter that is unique so that first letter selection may take place. File S_PULLDN.PRG --------------------------------------------------------------------- FUNCTION: PURGEM() Deletes records Deletes records Returns nothing Category DBF Syntax PURGEM() Description Deletes records of the currently opened DBF. Examples if clean_em_up select 0 use QUERIES PURGEM() endif Notes This is intended for those small system files created by QUERY(), FORMLETR(), LISTER() etc. No PACKING is done. File S_PURGEM.PRG --------------------------------------------------------------------- FUNCTION: QUERY() Popup Interactive query by example condition builder Popup Interactive query by example condition builder Returns <expC> macro expandable logical condition expression Category Metafunction Syntax QUERY([array1...array3],[expC]) Description A point and shoot condition builder. Complex conditions are allowed with multiple .and./.or. Called without parameters, all fields in the current dbf are presented for condition building. Options [array1],[array2],[array3] give field array, field description and field types.These, if passed will be used in place of the default of all dbf fields. (pass all or none) [expC] is a 'quit to' phrase. Default exit option is 'Quit'. 'Quit to' phrase will be tacked to the end of this . i.e. "Quit"+quit_to [ Quit to Report Writer ] Examples USE CUSTOMER private flds[3],fdes[3],ftyp[3] flds[1] = "fname" flds[2] = "lname" flds[3] = "mi" fdes[1] = "First Name" fdes[2] = "Last Name" fdes[3] = "Middle Initial" ftyp[1] = "C" ftyp[2] = "C" ftyp[3] = "C" filt = QUERY(flds,fdes,ftyp) set filter to &filt ... or ... USE CUSTOMER looker = QUERY() locate for &looker Notes Uses public variable 'QUERY_EXP'. This contains the current query expression, which is retained between calls of query, and is looked for by other SUPER functions. Will call BUILDEX() (expression builder - Metafunction optional module) if it is loaded in memory. The way to load BUILDEX is to declare it external i.e. EXTERNAL BUILDEX Structure for database : QUERIES.DBF Field Field Name Type Width Dec . 1 DBF Character 12 . 2 DES Character 30 . 3 FQUERY Character 220 Warnings Macro expanding the QUERY_EXP variable lengthens the command line on which it is expanded. If the command line goes beyond 254 characters, the program will bomb. If this becomes a problem, use the function called EVALQ() in your expression and pass query_exp to it. Then use it like so: LOCATE FOR EVALQ(m->query_exp) In Clipper 5.01, you're better off doing queryblock := &("{||"+query_exp+"}") locate for eval(queryblock) File S_QUERY.PRG --------------------------------------------------------------------- FUNCTION: QUIKREPORT() Runtime pre-defined report printing module Runtime pre-defined report printing module Returns Nothing Category REPORT Syntax QUIKREPORT([report name]) Description Presents a piklist of pre-defined reports and prints the selected one. Options [report name] name of the report to run - piklist is bypassed. Examples QUIKREPORT('Quarterly Hog Count') Warnings Requires DBF and indexes to be open Notes See INITSUP() for description of using an alternate name to SFREPORT.DBF. File R_QUIKR.PRG --------------------------------------------------------------------- FUNCTION: REPORTER() Create, modify, execute reports Create, modify, execute reports Returns Nothing Category REPORT Syntax REPORTER([array1],[array2],[array3]) Description Build/modify reports based on fields in database. Options Fields in database may be specified in arrays 1-3 which are 1. field names 2. field types 3. field lengths. Examples example 1: Use Customer REPORTER() example 2: USE Customer private flds[3],ftyp[3],flen[3] flds[1] = "fname" flds[2] = "lname" flds[3] = "mi" ftyp[1] = "C" ftyp[2] = "C" ftyp[3] = "C" flen[1] = 15 flen[2] = 25 flen[3] = 1 REPORTER(flds,ftyp,flen) Notes See INITSUP() for description of using an alternate name to SFREPORT.DBF. Found in (prgs) R_REPORT.PRG main file R_PRINTR.PRG print routines R_SAVE.PRG report definition SAVE routine R_LOADR.PRG report definition LOAD routine R_HDFOOT.PRG header/footer editing routine R_BROWSE.PRG column browse routine R_EDIT.PRG column editing routines R_ORDER.PRG grouping order routines R_LAYOUT.PRG page layout routines R_MAKEDB.PRG create sfreport.dbf Samples found in : SFREPORT.PRG sample report front end SFREPORT.DB* report definition datafiles - created when needed Operation LOAD REPORT load a pre-defined report into memory CREATE REPORT create a blank slate for a new report SAVE REPORT save a defined report to sfreport.dbf EDIT REPORT Insert, edit, delete report columns: Column Contents - may be a field, spaces, or a complex expression Column Title - is freeform text entry of the current column width and title Width - allows override of the default column width determined by expression length or title width. Values will be truncated or expanded to match. Pict - override default picture clause for Numeric fields Total - is a Y/N for total on numeric fields DELETE REPORTS Delete, pack obsolete reports HEADERS/FOOTERS Define Header and Footer size and contents FILTERING Select None, Query or Tagged GROUPING ORDER Select from open index keys the major and secondary grouping OTHER OPTIONS Page length (lines per page) Page width (characters across) Top Margin (in lines) Left Margin (in characters) Text of Major Group (text to indicate a major group change) Text of Minor Group (text to indicate a minor group change) Major underline character (for underlining totals) Minor underline character (for underlining subtotals) Underline totals (yes or no) Eject before report (yes or no) Eject after report (yes or no) Eject on Major change (yes or no) Eject on Minor change (yes or no) Eject before Grand Totals (yes or no) Eject if # lines left (means eject if # or less lines remain on the page and a group change was just done) Pause between pages (yes or no) Number of title lines (1 or 2) Detail line separator (character) Depth of detail separator (line spacing 0 or 1) Column separator (character) Title/body/footer separator (character) Include standard 2-line header with page# and date (yes or no) Full or Summary Report (F/S) Printer setup code (decimal, like 1-2-3, i.e. 27,15 for compressed) to send before report Printer exit code to send after report PRINT REPORT Allows PRINTER/DISK selection, start at page # (for recovery). While printing, SPACE will pause and ESCAPE will quit the report. QUIT Exit report writer Structure for SFREPORT.DBF SF_DBF Character 8 Dbf name SF_NDXKEY Character 60 Sort key(index) SF_MAJKEY Character 60 Major sort key SF_MINKEY Character 60 Minor sort key SF_TITLE Character 35 Report name SF_MAJTEXT Character 25 Major key text SF_MINTEXT Character 25 Minor key text SF_WIDTH Numeric 3 Pg width chrs SF_LENGTH Numeric 3 Pg length lines SF_LEFTM Numeric 2 Left margin SF_TOPM Numeric 2 Top margin SF_SPACE Numeric 1 Line spacing SF_PAUSE Logical 1 Pause between SF_NPLINES Numeric 1 Lines left SF_EJB4 Logical 1 Eject b4 report SF_EJAFT Logical 1 Eject aftreport SF_EJMAJOR Logical 1 Eject on Major SF_EJMINOR Logical 1 Eject on Minor SF_EJGRAND Logical 1 Eject b4 Grand SF_UNTOTAL Logical 1 Underline ttals SF_MAJCHR Character 1 Major underline character SF_MINCHR Character 1 Minor underline character SF_NHEAD Numeric 1 # header lines SF_NFOOT Numeric 1 # footer lines SF_NTITL Numeric 1 # title lines SF_TSEP Character 1 Title separation char SF_COLSEP Character 1 Col sep char SF_CSEPWID Numeric 1 Col sep width SF_LINESEP Character 1 Line sep char SF_NCOLS Numeric 2 # columns SF_FEET Memo 10 Footer contents SF_HEADS Memo 10 Header contents SF_STDHEAD Logical 1 Use standard header SF_DETAILS Memo 10 Detail contents SF_QUERY Character 100 Last used query SF_FULLSUM Character 1 Full / summary SF_PRNCODE Character 50 Printer code pre-report SF_AFTCODE Character 50 Printer code post-report --------------------------------------------------------------------- FUNCTION: RJUST() Right justifies a string Right justifies a string Returns <expC> string right justified Category String Syntax RJUST(<expC>) Description Right justifies <expC> Examples string = "Superfunction " string = RJUST(string) (returns " Superfunction" File S_RJUST.PRG --------------------------------------------------------------------- FUNCTION: SADD_REC() Attempts to append a blank record Attempts to append a blank record Returns <expL> success Category NETWORK Syntax SADD_REC(<expN>,<expL>,<expC>) Description Attempts to append a blank record. Tries <expN> times and then allows user to retry or not <expL2> by giving message <expC3> and asking YES/NO. Examples IF SADD_REC(5,.T.,"Unable to ADD,Try again?") IF SREC_LOCK(5,.T.,"Unable to lock, Try; again?") REPLACE XXX WITH YYY, ZZZ WITH BBB UNLOCK ELSE LOOP ENDIF ELSE LOOP ENDIF File S_SADDR.PRG --------------------------------------------------------------------- FUNCTION: SCMOD() Maintains scroller.dbf - see scroller() Maintains scroller.dbf - see scroller() Returns nothing Category Development Syntax SET KEY xxx to SCMOD Description SCMOD() is a tool for online building and modifying of the SCROLLER.DBF used for SCROLLER() lookup tables. When called by a SET KEY, it recieves the PROCEDURE and VARIABLE parameters from the calling PROCEDURE. It then determines if there exists a matching record in the SCROLLER.DBF. If so, the lookup definition may be modified. Otherwise, a new lookup definition may be created. Examples EXTERNAL SCMOD SET KEY -31 TO SCMOD && ALT-F2 Notes Be sure to declare SCMOD external. SCROLLER.DBF has the structure : calling procedure.. 1 SMODULE C 10 calling variable.... 2 SFIELD C 10 description........ 3 SDESCR C 25 display string..... 4 SSTRING C 160 return string..... 5 SRETURN C 75 dbf file to lookup.. 6 SDBFILE C 8 index to use..... 7 SIND C 8 SCMOD() will create SCROLLER.DBF if it doesn't exist. File S_SCMOD.PRG --------------------------------------------------------------------- FUNCTION: SCROLLER() Hotkey lookup tables with dbf storage Hotkey lookup tables with dbf storage Returns nothing Category Lookup Syntax SET KEY xxx TO SCROLLER Scroller([expC1],[expN],[expC2]) Description Scroller is a hotkey lookup table engine. Scroller is data-driven , meaning it operates on data stored external to the EXE in SCROLLER.DBF. SCROLLER() is called via a SET KEY. When called, it recieves the parameters proc_nam and VARIABLE from Clipper, tellingit the proc and variable the user was sitting on when he pressed the hotkey. The actual parameters rec'd areproc_nam, LINE, VARIABLE. Line is ignored, but it s included as the 2nd parameter because it is passed. SCROLLER() attemps to find a corresponding record in SCROLLER.DBF (which contains fields for proc_nam and VARIABLE). SCROLLER.DBF is a storage place for lookup definitions. If SCROLLER does not find a matching record, it simply closes SCROLLER.DBF and returns to the previous area. It then displays a 'lookup table not found' message. If SCROLLER finds a matching record, it loads the values into memory and closes SCROLLER.DBF. It then opens the DBF [and index] of the lookup dbf in the next available area. If it is unable to open the dbf, it displays an error message and goes back to the previously selected area. SCROLLER then draws a box, using the DESCRIPTION field as the title, ititializes a 1 element array composed of the SSTRING expression and calls SMALLS() . While in the SMALLS(), first letter searches can be done if the dbf is indexed with a character index. Pressing ENTER will KEYBOARD the expression in SRETURN (unless its empty), close up the current area and return to the old area. Pressing escape just closes things up and returns to the old area. The KEYBOARD then takes over, feeding the SRETURN expression into the keyboard and into the current GET or GETS. Examples EXTERNAL SCROLLER SET KEY -1 TO SCROLLER && F2 ..or Warnings Be sure to declare SCROLLER EXTERNAL! File S_SCROLL.PRG --------------------------------------------------------------------- FUNCTION: SEARCHME() Search a DBF with user-specified criteria Search a DBF with user-specified criteria Returns Nothing Category Metafunction Syntax SEARCHME([array1],[array2],[array3]) Description Searches the current dbf with criteria given by the user. for : Field Contents Match Query match End of file Beginning of File Deleted Records Memo contents Options Three arrays may be passed for FIELDS <array1>, FIELD TYPES <array2>, and FIELD LENGTHS <array3>. Examples if choice = 5 SEARCHME() endif File S_SEARCH.PRG --------------------------------------------------------------------- FUNCTION: SETCENT() Determines if century is on/off Determines if century is on/off Returns <expL> on/off Category Date Syntax <expL> = SETCENT([expL]) Description Returns current SET CENTURY setting and optionally sets century on/off [expL] Options [expL] .t. = ON .f. = OFF Examples oldcentury = SETCENT(.f.) && SET CENTURY OFF * code SETCENT(oldcentury) File S_SETCEN.PRG --------------------------------------------------------------------- FUNCTION: SETCOLORS() Interactive color setting interface Interactive color setting interface Returns nothing Category Development Syntax SETCOLORS() Description This is a development tool for finding nice combinations of colors for the global superfunction colors. I would not give this to an end user, as it is just TOO MANY CHOICES! I normally select 10-15 nice combinations of the colors and give the user a selection of those, giving them such names as 'Hawaiian Blue' or 'Royal Red'. First, a word on the Superfunction color scheme: This is not the perfect color scheme. It is the one on which this library runs. (hey - I hadda pick something) I also realize full well that color selection is more art than it is technical, and it is difficult to get two people to agree on a color scheme. Several global (public) color variables are used by the functions. These are: c_normcol - For normal input/output c_normmenu - For normal 'menu to' operations c_popcol - For popup box colors c_popmenu - For popup box menus c_frame - Frame string c_shadatt - Shadow color attribute (numeric) c_shadpos - Shadow position (0,1,3,7,9) c_xplode - Logical - explode windows? All are of the format "f/b,f/b,,,f/b" (f-foreground b-background) The function INITSUP() will initialise these colors SETCOLORS() allows interactive setting of these colors. The variables are stored in COLORS.MEM - which is created if needed by SETCOLORS(). If COLORS.MEM is not present, INITSUP() will initialise a default set of colors, otherwise it will restore from colors.mem Examples SETCOLORS() * then initialize the colors restore from colors.mem addit * then set the colors SET COLOR TO (C_normcol) Notes SETCOLORS() does not effect the current color setting. It manipulates COLORS.MEM. To utilize colors selected by SETCOLORS(), a restore from COLORS.MEM must be done. See also COLPIK() See also INITSUP() See also Appendix C Warnings I've had problems with old copies of COLORS.MEM (from previous versions) and also with COLORS.MEM created by other programs. If you run into troubles, try erasing COLORS.MEM. File S_SETCOL.PRG --------------------------------------------------------------------- FUNCTION: SET_DATE() Sets and restores date format Sets and restores date format Returns <expN> previous SET DATE format 1-5 Category Date Syntax <expN> = SET_DATE([expN]) Description Return current SET DATE setting <expN> and optionally set to new format [expN] Options [expN] = 1 American 2 British/French 3 German 4 ANSI 5 Italian Examples oldformat = SET_DATE(5) ** SET TO ITALIAN * code * more code SET_DATE(oldformat) && restore to prior setting File S_SETDAT.PRG --------------------------------------------------------------------- FUNCTION: SETEXACT() Determines if exact is on/off Determines if exact is on/off Returns <expL> on/off Category Date Syntax <expL> = SETEXACT([expL]) Description Returns current SET EXACT setting and optionally sets century on/off [expL] Options [expL] .t. = ON .f. = OFF Examples oldexact = SETEXACT(.f.) && SET EXACT OFF * code SETEXACT(oldexact) File S_SETEX.PRG --------------------------------------------------------------------- FUNCTION: SFIL_LOCK() Attempts to lock a file Attempts to lock a file Returns <expL> success Category NETWORK Syntax SFIL_LOCK(<expN>,<expL>,<expC>) Description Attempts to lock entire DBF file. Tries <expN> times and then allows user to retry or not <expL2> by giving message <expC3> and asking YES/NO. Examples IF SFIL_LOCK(5,.F.) PACK UNLOCK ELSE LOOP ENDIF File S_SFILOK.PRG --------------------------------------------------------------------- FUNCTION: SMALLS() Lookup tables on dbf - no call to dbedit <small> Lookup tables on dbf - no call to dbedit <small> Returns nothing Category Lookup Syntax Smalls(expC,[expC],[expC/N],[expC],; [expC/N],[expCN) Description This is a next generation lookup engine, and is the Son of Scroller(). (smalls = small scroller) and is actually called by SCROLLER() It is called directly as follows: 1. ExpC the display string for the lookup box. Options 2. ExpC a title for the lookup box 3. ExpC/ExpN A. alias name or B. numeric work area or C. dbf/ndx in the format: "%dbfname%ndxname" 4. ExpC expression to keyboard if ENTER pressed 5. ExpC/N numeric- starting record character - starting key (only if indexed) 6. ExpC/N numeric - ending record character - ending key (only if indexed) Examples (assumes dbf fields of LNAME and FNAME) * lookup on "LNAME+' '+FNAME" in current area smalls("LNAME+' '+FNAME") ...or * lookup on "LNAME+' '+FNAME" in current area * use "Name" as box title smalls("LNAME+' '+FNAME","Name") ...or * lookup on "LNAME+' '+FNAME" in current area * use "Name" as box title * go to area 5 for the lookup * send LNAME to the keyboard if CR pressed smalls("LNAME+''+FNAME","Name",5,"LNAME") ...or * lookup on "LNAME+' '+FNAME" in current area * use "Name" as box title * go to alias CUSTOMER for the lookup smalls("LNAME+''+FNAME","Name","CUSTOMER") ...or * open customer.dbf and do a lookup on it * lookup on "LNAME+' '+FNAME" * use "Name" as box title smalls("LNAME+''+FNAME","Name","%CUSTOMER") * open customer.dbf and do a lookup on it * lookup on "LNAME+' '+FNAME" * use "Name" as box title * limit lookup to between records 50 and 60 smalls("LNAME+''+FNAME","Name","%CUSTOMER",50,60) * open CUSTOMER.DBF with LNAME.NDX and do a lookup * lookup on "LNAME+' '+FNAME" * use "Name" as box title smalls("LNAME+''+FNAME","Name","%CUSTOMER%LNAME") * open CUSTOMER.DBF with LNAME.NDX and do a lookup * lookup on "LNAME+' '+FNAME" * use "Name" as box title * limit lookup to JAAAA-ZZZZZ smalls("LNAME+''+FNAME","Name","%CUSTOMER%LNAME",; "JAAAAA","ZZZZZ") Notes The display string must evaluate to a character expression when macro-expanded. For instance, a date field called CDATE would crash if passed as smalls("CDATE"), as it would evaluate to date type, but if passed as smalls("dtoc(CDATE)" all would be well. The KEYBOARD expression must also evaluate to type CHARACTER Warnings SOFTSEEK is left OFF File S_SMAL.PRG --------------------------------------------------------------------- FUNCTION: SNET_USE() Attempts to pen a DBF Attempts to pen a DBF Returns <expL> for success Category NETWORK Syntax SNET_USE(<expC1>,<expC2>,<expL1>,<expN>, <expL2>,<expC3> Description Attempts to open a DBF file <expC1> with alias of <expC2>, opening EXCLUSIVE or NOT <expL1>. Tries <expN> times and then allows user to retry or not <expL2> by giving message <expC3> and asking YES/NO. Examples IF SNET_USE("CUSTOMER.DBF","CUSTOMER",; .F.,5,.T.,"Unable to open CUSTOMER.DBF.; Try again?") SET INDEX TO CUSTOMER,ACCTNO ELSE MSG("Unable to proceed, returning to; menu") loop ENDIF File S_SNETU.PRG --------------------------------------------------------------------- FUNCTION: SREC_LOCK() Attempts to lock a record Attempts to lock a record Returns <expL> success Category NETWORK Syntax SREC_LOCK(<expN>,<expL>,<expC>) Description Attempts to lock current record. Tries <expN> times and then allows user to retry or not <expL2> by giving message <expC3> and asking YES/NO. Examples IF SREC_LOCK(5,.T.,"Unable to lock record. ; Try again?") REPLACE XXX WITH YYY, ZZZ WITH BBB UNLOCK ELSE LOOP ENDIF File S_SRECLO.PRG --------------------------------------------------------------------- FUNCTION: STANDARD() Returns color integer for standard setting Returns color integer for standard setting Returns nothing Category Screen Syntax <expN> = STANDARD() Description Returns numeric color integer for use with functions which require it like ATT(), PRNT(). Examples stan = standard()+128 && blinking PRNT(10,10,"Waiting...",m->stan) File S_STAN.PRG --------------------------------------------------------------------- FUNCTION: STARTSW() Determines if a string starts with another string Determines if a string starts with another string Returns <expL> Category Logical Syntax STARTSW(<expC>,<expC) Description Determines if string 1 <expC1> starts with string 2 <expC2> Examples str1 = "SUPERFUNCTION" str2 = "SUPER" str3 = "SOUP" STARTSW(str1,str2) returns .t. STARTSW(str1,str3) returns .f. File S_STARTS.PRG --------------------------------------------------------------------- FUNCTION: STOD() Returns date from string in the form YYYYMMDD Returns date from string in the form YYYYMMDD Returns <expD> date from string Category Date Syntax STOD(<expC>) Description Returns date from string of the form YYYYMMDD <expC> Examples strdate = "19890102" newdate = STOD(strdate) (returns 01/01/89 type date) File S_STOD.PRG --------------------------------------------------------------------- FUNCTION: STRETCH() Imbeds characters in a string Imbeds characters in a string Returns <expC> string with characters imbedded Category String Syntax STRECH(<expC>,<expC>,<expN>) Description Imbeds character <expC2> in string <expC1> every <expN> character Examples string = "SUPERFUNCTION" string = STRETCH(string,' ',1) (returns "S U P E R F U N C T I O N") Notes This hombre might be called EXPAND in other parts File S_STRETC.PRG --------------------------------------------------------------------- FUNCTION: STRIP_PATH Strips path from a filespec Strips path from a filespec Returns <expC> file name with or without extension Category NETWORK Syntax STRIP_PATH(<expC>,<expL>) Description Takes filespec <expC> and strips away drive and directory information. If <expL> = .t., also strips away extension. Examples STRIP_PATH("C:\OGRE\WITCH\FORMULA.DBF",.F.) = "FORMULA.DBF" STRIP_PATH("C:\OGRE\WITCH\FORMULA.DBF",.T.) = "FORMULA" File S_STRPAT.PRG --------------------------------------------------------------------- FUNCTION: STRPULL() Extract text between 2 characters Extract text between 2 characters Returns <expC> text extracted Category String Syntax STRPULL(<expC>,<expC>,<expC>) Description Extracts text from <expC1> between characters <expC2> and <expC3>. If <expC2> is empty, uses beginning of <expC1>. If <expC3> is empty, uses end of <expC1>. Examples string = "SUPERFUNCTION" string = STRPULL(string,'E','C') (returns "RFUN") File S_STRPUL.PRG --------------------------------------------------------------------- FUNCTION: SUBPLUS() Returns multiple substrings Returns multiple substrings Returns <expC> new string from multiple substrings Category String Syntax SUBPLUS(<expC>,<expN1>...<expN8>) Description Extracts from string <expC> from position <expN1> for <expN2>, <expN3> for <expN4> etc. Examples string = "PREFONTAINE" garble = SUBPLUS(string,6,1,5,1,1,1,3,1) ?garble = "NOPE" File S_SUBPLU.PRG --------------------------------------------------------------------- FUNCTION: SUM_AVE() Interactive sum or average on a dbf field Interactive sum or average on a dbf field Returns nothing Category Metafunction Syntax SUM_AVE([expC]) Description Does a SUM or AVERAGE on a selected numeric field Options [expC] "SUM" or "AVE". Default is "SUM" Examples case choice = 3 && sum SUM_AVE("SUM") case choice = 4 && average SUM_AVE("AVE") Notes If QUERY_EXP is present - public variable used by QUERY() - optional SUM or AVERAGE for QUERY_EXP can be done. File S_SUMAV.P --------------------------------------------------------------------- FUNCTION: TAGIT() Allows tagging of dbf records for later action Allows tagging of dbf records for later action Returns nothing - modifies array passed by reference Category Metafunction Syntax TAGIT(<array1>,[array2],[array3],[expC]) Description Performs a no-touch tag on records in the dbf. It does this by filling <array1> - an array which you need to initialize to the max # of records you want to tag - with tagged record numbers. DBEDIT() is called with a UDF to show on screen what records have been tagged. Ascan may then be used with the array to evaluate to a logical condition for searches, copies, printing etc. with the general syntax of: (ascan(<array1>,recno()) > 0) Options [array2] and [array3] may be passed as fields and field descriptions. These are then passed to DBEDIT() as the fields and titles arrays. [expC] is a title for the dbedit box Examples private tag[100] tagit(tag,"","","Tag records to copy") copy to temp for (ascan(tag,recno()) > 0) File S_TAG.PRG --------------------------------------------------------------------- FUNCTION: TIMEPER() Time Period (date sensitive) DBF analysis Time Period (date sensitive) DBF analysis Returns nothing Category Metafunction Syntax TIMEPER([array1],[array2],[array3]) Description Does a menu-driven time/date sensitive analysis of a DBF based on DATE type fields in the DBF, by sorting data into time periods Time periods can be: A By Week B Week to Date C By Month D Month to Date E By Year F Year to date G User defined Additional numeric fields may be tallied withing each time period. Options [array1] array of field names [array2] array of field descriptions [array3] array of currently open indexes for re-opening on exit Warnings Restore your indexes after using this function, as it creates a new index and you will lose the SET INDEX...unless you pass the third param as an array of open indexes Examples private flds[3],fdes[3],openntx[3] flds[1] = "fname" flds[2] = "lname" flds[3] = "mi" fdes[1] = "First Name" fdes[2] = "Last Name" fdes[3] = "Middle Initial" openntx[1]="CUSTOMER" openntx[2]="CITY" openntx[3]="STATE" TIMEPER(flds,fdes,openntx) && pass both or none && of the 1st two arrays ...or openntx[1]="CUSTOMER" openntx[2]="CITY" openntx[3]="STATE" TIMEPER("","",openntx) && pass nulls for &&first 2 params File S_TIME.PRG --------------------------------------------------------------------- FUNCTION: TODOLIST() Simple todo list manager Simple todo list manager Returns Nothing Category Metafunction Syntax TODOLIST() Description Pops up a simple TODO list interface, allowing the user to enter in things 'To do' by Description, Category ,Priority and Date Due. These categories may be sorted, filtered and printed. Examples TODOLIST() File S_TODO.PRG --------------------------------------------------------------------- FUNCTION: TRUEVAL() Returns val of ALL numerics in a string Returns val of ALL numerics in a string Returns <expN> value Category Conversion Syntax TRUEVAL(<expC>) Description Removes all non-numeric characters from a string, and then converts it to numeric. Examples string = "SUPERFUNCTION Library version 1.50" number = TRUEVAL(string) (returns 1.50) File S_TRUEVA.PRG --------------------------------------------------------------------- FUNCTION: UNBOX() Removes a box created by makebox() Removes a box created by makebox() Returns nothing Category Popup Syntax Unbox(<expC>,[expN1..expN4]) Description UNBOX restores the screen <expC> saved by MAKEBOX(). MAKEBOX() stores the dimensions and color in the returned string, so it is not necessary to pass these to UNBOX(). If the dimensions are passed, UNBOX() assumes these are not part of the saved string, and assumes the string is a savescreen() string. If the string and any other single param are passed, UNBOX() assumes it is a full screen (0,0,24,79) restore and does so. Options [expN1..expN4] - the dimensions of the box. Use these to UNBOX() a screen saved with SAVESCREEN(). Examples msg = MAKEBOX(10,40,12,60,'W/R,+GR/R') @11,42 SAY "What's up, Doc ?" inkey(0) UNBOX(m->msg) ..or unboxing a SAVESCREEN() screen msg = savescreen(5,5,10,10) *code unbox(msg,5,5,10,10) ..or unboxing a full screen save screen to msg *code unbox(msg,<anyparam>) File S_UNBOX.PRG --------------------------------------------------------------------- FUNCTION: UNIQFNAME() Creates a unique file name Creates a unique file name Returns <expC> file name Category NETWORK Syntax UNIQFNAME(<expC1>,<expC2>,[expC3]) Description Attempts to create a unique file name <expC1> extension for file <expC2> path to check Options [expC3] prefix (first letter) of file name (defaults to U) Examples tempfile = UNIQFNAME("DBF","") tempfile = UNIQFNAME("NTX","C:\local\") File S_UNIQF.PRG --------------------------------------------------------------------- FUNCTION: UNSELECTED() Returns color integer for UNSELECTED setting Returns color integer for UNSELECTED setting Returns <expN> numeric color integer Category Screen Syntax <expN> = unsel Description Returns numeric color integer for use with functions which require it like ATT(), PRNT(). Examples enhan= enhanced()+128 && blinking PRNT(10,10,"Waiting...",m->enhan) File S_UNSEL.PRG --------------------------------------------------------------------- FUNCTION: VAR2CHAR() Converts any type variable to character type Converts any type variable to character type Returns <expC> character Category String Syntax Var2char(<expC>) Description Converts variable named in <expC> to type character Examples dtype = ctod("01/01/80") ntype = 128.45 ltype = .t. VAR2CHAR("dtype") returns "01/01/80" VAR2CHAR("ntype") returns "128.45" VAR2CHAR("ltype") returns ".t." Warnings Numerics will be returned with a length of 10 minimum You may wish to trim this. Notes Returns memo types as "" File S_VAR2.PRG --------------------------------------------------------------------- FUNCTION: VARLEN() Returns length of a variable of any type Returns length of a variable of any type Returns Length of variable Category Editing Syntax Varlength(exp?] Description Converts exp? to character with VAR2CHAR() and then returns its length Examples VARLEN(123.45) returns 6 VARLEN(.F.) returns 3 VARLEN(DATE()) returns 8 File S_VARLEN.PRG --------------------------------------------------------------------- FUNCTION: VIEWPORT() Multi-optional data entry engine Multi-optional data entry engine Returns nothing Category Metafunction Syntax VIEWPORT([expL],[array1...array7],[expL]) Description Presents a generic data entry screen with multiple movement, search, view and editing capabilities. Options [expL] Logical - this is .T. if you want to give the user Add,Edit,Delete, and .F. if not. Defaults to .T. Arrays 1-5 and array 7 must have the same # of elements. (default is # of fields in DBF). You may pass a .f. or a "" to bypass and activate the default. [array1] An array of field names. Defaults to all fields in DBF. [array2] An array of field descriptions. Defaults to field names. You must pass array1 if you wish to pass array2. [array3] is an array of PICTURES as Character expressions to correspond with the FIELDS array. Default is pictures as derived by ED_G_PIC() If you pass this array, each element must contain at least a "". [array4] is an array of VALID clauses and messages to correspond with the FIELDS array. Each is in the form "{valid clause};{valid message}" The FIELD is represented as a token "@@" in the valid clause which is replaced with the current edited value at edit time. i.e. "!empty(@@);Must not be empty" If you pass this array, each element must contain at least a "". [array5] is an array of Lookup definitions corresponding to the FIELDS array. These are delimited strings with 1-4 component parts matching the first four parameters of SMALLS(). Delimiter is a semicolon (;). As an example, to make a lookup definition corresponding to the COMPANY field in the FIELDS array, which will lookup on the field CORPNAME in the database INSTIT, titling the box "Company" and KEYBOARDing the contents of CORPNAME if CR pressed : "CORPNAME;Company;%INSTIT;CORPNAME". If you realize that these 4 components are parsed and sent as parameters to SMALLS(), you will get the idea. If you pass this array, each element must contain at least a "". [array6] [1-9] Character - each of elements 1-9 is a delimited string in the format "{option};{action}" where option is a displayed menu option and action is a proc to be executed. i.e.: "Form Letters;FORMLETR()" "List Myfile;FILEREAD(2,2,22,78,'FMYFILE.TXT')" Pass 1-9 option/proc combinations. These will be presented as an 'Other' menu. THESE PROCS MUST BE DECLARED EXTERNAL!!! [array7] Logical - matches the FIELDS array and defines which fields may be edited (.t.) and which are display only (.f.) If you pass this array, each element must be of TYPE Logical. [expL] Logical - pop up 'Carry Forward' message when adding? True/False. Default is True. Examples use register private flds[fcount()] private fdes[fcount()] private fval[fcount()] private floo[fcount()] private fedit[fcount()] afields(flds) afields(fdes) afill(fval,"") afill(floo,"") afill(fedit,.t.) - valids for fields 5 and 6 fval[5]="!empty(@@);Cannot be empty" fval[6]="!empty(@@);Cannot be empty" * *- lookups for fields 5 and 6 floo[5] = "First;First Name;%user%;trim(first)" floo[6] = "Last;Last Name;%user;trim(Last)" *- 'other' menu array private oth[3] oth[1] = "Read PRG;FILEREAD(1,1,23,79,'s_viewp.prg')" oth[2] = "Do Form Letters ;FORMLETR()" oth[3] = "Frequency Analysis;FREQANAL()" * be sure the 'other' procs are pulled in EXTERNAL FILEREAD,FREQANAL,FORMLETR VIEWPORT(.t.,flds,fdes,.f.,fval,floo,oth) File S_VIEWP.PRG --------------------------------------------------------------------- FUNCTION: WOMONTH() Calculates week of the month (# of 7 day periods) Calculates week of the month (# of 7 day periods) Returns <expN> week of the month Category Date Syntax WOMONTH(<expD>) Description Calculates current number of 7 day periods for the month from <expD> Examples adate = ctod("10/15/90") dom = WOMONTH(adate) (returns 3) File S_WOMON.PRG --------------------------------------------------------------------- FUNCTION: WOYEAR() Calculates week of the year (# of 7 day periods) Calculates week of the year (# of 7 day periods) Returns <expN> week of the year of date Category Date Syntax WOYEAR(<expD>) Description Calculates number of 7 day periods passed for the year from <expD> Examples adate = ctod("10/15/90") dom = WOYEAR(adate) (returns 40) File S_WOYEAR.PRG --------------------------------------------------------------------- FUNCTION: WRITEFILE() Writes a line or lines to a text file Writes a line or lines to a text file Returns nothing Category File Syntax Writefile(<expC1|expN>,<expC2>) Description Writes line(s) of text with CR LF to a file referenced either as a file handle <expN> or a filename <expC1>. Writes either a single line contained in <expC2> or all of the contents of a character array named as <expC2> to the file. Examples 1. WRITEFILE('ERROR.TXT','THERE WAS AN ERROR') 2. declare errors[3] errors[1] = 'There was an error' errors[2] = 'Error # 61765 ' errors[3] = dtoc(date) writefile('ERROR.TXT','ERRORS') 3. handle = fopen("error.txt",1) declare errors[3] errors[1] = 'There was an error' errors[2] = 'Error # 61765 ' errors[3] = dtoc(date()) writefile(handle,'ERRORS') Notes If a filename is passed, the file is opened and closed by the function. If a file handle is passed, the file is left open. If a character array name is passed, each element is written to a seperate line in the file. Do not pass an array - pass an array name in quotes If the file does not exist, it is created. File S_WRITEF.PRG C AND ASSEMBLER FUNCTIONS ------------------------- ----------------------------------------------------------------- FUNCTION::ALENG() Determines initialized length of an array ALENG() Purpose : Determines initialized length of an array Usage : Aleng(<array>) Params : <array> the array you wish to determine the length of Returns : Length of the array Found in: aleng.c ----------------------------------------------------------------- FUNCTION::ATT() Change attribute of area of the screen ATT() Purpose : Change attribute of area of the screen Usage: Att(<expN1>, <expN2>, <expN3>, <expN4>, <expN5>, [expC] ) Params : expN1 - top row expN2 - left col expN3 - bottom row expN4 - right column expN5 - attribute to set area expC - character to fill area with Returns : nothing. Found in: att.c ----------------------------------------------------------------- FUNCTION::ATTT() Used by C functions to color a screen area ATTT() Purpose : Used by C functions to color a screen area Usage: See relevent C functions. To be called from a C function ONLY. Use ATT() from Clipper. Found in: attt.c ----------------------------------------------------------------- FUNCTION::BIGELEM() Returns length of longest character element BIGELEM() Purpose : Returns length of longest character element in array Usage: Bigelem(<array>) Params : <array> the array you wish to determine longest element of Returns : Length of the longest element Found in: bigel.c ----------------------------------------------------------------- FUNCTION::BXX() Draw a box on the screen with attribute and shadow BXX() Purpose : Draw a box on the screen with attribute and optional shadow Usage: Bxx(<expN1>, <expN2>, <expN3>, <expN4>, <expN5>, <expN6> <expN7>,<expC>) Params : expN1 - top row expN2 - left col expN3 - bottom row expN4 - right column expN5 - attribute to box expN6 - numeric shadow type (default 0) follow numeric keypad 7 = upper left 1 = lower left 3 = lower right 9 = upper right 0 = no shadow expN7 - shadow attribute (default 7 - grey on black) expC - frame string - MUST be 9 characters - default single Returns : nothing. Found in: bxx.c ----------------------------------------------------------------- FUNCTION::CAPSLOCK() sets capslock on CAPSLOCK() Purpose : sets capslock on Usage: Capslock() Params : nada Returns : nada Found in: s_caps.c ----------------------------------------------------------------- FUNCTION::CAPSLOFF() sets capslock off CAPSLOFF() Purpose : sets capslock off Usage: Capsloff() Params : nada Returns : nada Found in: s_caps.c ----------------------------------------------------------------- FUNCTION::CDIR() Change to new directory CDIR() Purpose : Change to new directory Usage: Cdir(<expC>) Params : <expC> a valid directory on current drive Returns : .t. if succesful, .f. otherwise Found in: cdd.asm ----------------------------------------------------------------- FUNCTION::C_GRID() Draws screen in SETCOLORS() function C_GRID() Purpose : Draws screen in SETCOLORS() function Usage: c_grid(<expN>,<expN>) Params : <expN1-2> Coordinates of top-left corner Returns : nothing Found in: c_grid.c ----------------------------------------------------------------- FUNCTION::CURD() Return current drive letter CURD() Purpose : Return current drive letter Usage: <expC>=CURD() Params : None. Example : @10,10 say "Current Drive :"+curd() Returns : Current drive letter Found in: curd.c ----------------------------------------------------------------- FUNCTION::FADEAWAY() Fades a screen variable off the screen FADEAWAY() Purpose : Fades a screen variable off the screen Usage: Fade(<expC>,<expN1..4>,<expN5>) Params : expN1..4 - coordinates of the saved screen expC - the saved screen expN5 - relative speed of fade - try 10 Example : fade(tbox,top,left, bot,right,10) Returns : diddly Found in: fade.c ----------------------------------------------------------------- FUNCTION::_GVIDM() Used by Super - C functions to determine _GVIDM() Purpose : Used by Super - C functions to determine video mode Usage: See relevent C functions. To be called from a C function ONLY. Use ISCOLOR() from Clipper. Found in: gvidm.asm ----------------------------------------------------------------- FUNCTION::IMBOX() Implodes a screen variable off the screen IMBOX() Purpose : Implodes a screen variable off the screen Usage: Imbox(<expN1..4>,<expC>,<expN5>) Params : expN1..4 - coordinates of the saved screen expC - the saved screen expN5 - relative speed of implosion - try 20 Example : imbox(box_top,box_left,; box_bot,box_right,tbox,20) Returns : diddly Found in: unbox.c ----------------------------------------------------------------- FUNCTION::ISPRN() Check if printer ready LPT1 LPT2 LPT3 ISPRN() Purpose : Check if printer ready LPT1 LPT2 LPT3 Usage: Isprn<expN>) Params : LPT1 - 0, LPT2 - 1, LPT3 - 2 Example : if ISPRN(0) Returns : <expL> indicating printer ready/online Found in: isprn.asm ----------------------------------------------------------------- FUNCTION::NEWDRV() Change to a new drive NEWDRV() Purpose : Change to a new drive Usage: Newdrv(<expC>) Params : expC - drive letter (ABCDE..) Example : Newdrv("C") Returns : diddly Found in: newdr.asm ----------------------------------------------------------------- FUNCTION::PRNT() Write string to row/col with attribute PRNT() Purpose : Write string to row/col with attribute Usage: Prnt(<expN1>, <expN2>, <expC>, <expN3>) Params : expN1 - row expN2 - col expC - String to write expN3 - color attribute of string Example : Prnt(10,10,"Hello, Dolly , yes hello,Dolly",23) Found in: prnt.c ----------------------------------------------------------------- FUNCTION::SET() Grabs S87 internals to emulate Clipper 5 SET() SET() Purpose : Grabs S87 internals to emulate Clipper 5.0's SET() command. Supports a subset of 5.0's SET() command for use with Super.Lib. Does not take a 2nd param, like 5.0's SET(). The numbering system corresponds to Clipper 5.0's SET settings. There are other internals that could emulate other SET() settings, but these were all I needed for Super.Lib. Usage: set(<expN>) Params : <expN> - the number of the internal setting (see list below) # Setting Returns ---------------------------------- 7 DEFAULT C 16 CURSOR ON/OFF N (0=off,1=on) Found in: S87SET.C ----------------------------------------------------------------- FUNCTION::SETKEY() Grabs S87 internals to emulate Clipper 5 SETKEY() SETKEY() Purpose : Grabs S87 internals to emulate Clipper 5.0's SETKEY() command, except param # 2 is not a code block but a pointer. Usage: SETKEY(<expN>,[expX]) Params : <expN> - the inkey value of the SET KEY Options : [ExpX] - a previously returned value from SETKEY() Example : * save F1 oldF1 = SETKEY(28) ..code.. * restore F1 SETKEY(28,oldF1) Found in: S87SETK.C ----------------------------------------------------------------- FUNCTION::SHIFTR() Slides a screen variable off the screen Function: Shiftr() Purpose : Slides a screen variable off the screen Usage: Shiftr(<expC>,<expN1..4>,<expN5>) Params : expN1..4 - coordinates of the saved screen expC - the saved screen expN5 - relative speed of shift - try 3 (based on # of columns per shift) Example : Shiftr(tbox,box_top,box_left,; box_bot,box_right,3) Returns : diddly Found in: shift.c ----------------------------------------------------------------- FUNCTION::TAKEOUT() Extract section of a string between delimiters TAKEOUT() Purpose : Extract section of a string between delimiters Usage: Takeout(<expC1>, <expC2>, <expN>) Params : expC1 - string expC2 - delimiter (beginning and end of string are considered delimiters) expN - occurance Example : takeout("Next:Previous:First:Quit",":",3) returns "First" Returns : Section of string between delimiters, occurance <expN>. Found in: between.c ----------------------------------------------------------------- FUNCTION::_WILDCARD() Wild Card String Compare. _WILDCARD() Purpose : Wild Card String Compare. Usage: <expL> = _wildcard(<expC>,<expC>) Params : <expC1> - model/wildcard pattern to search for <expC2> - string to compare with model/ pattern Model/Pattern description ------------------------ String of wild cards interspersed with literal text to compare against the contents of <expC2>. The following conventions for wild cards are followed: "*" stands for any group of characters. For example: W*r gives fields beginning with "W", ending with "r" *w*r gives fields having "w" before last character "r" "?" stands for any single character. For example: J?n?s gives Janes, Janus, Jones, and so on. Example : _wildcard("Fi?sewa*rma?", "Fitswatterman" ) returns -> True _wildcard("banana??*","Fitswatterman") returns -> False Credits : 07/24/89 PAT WEISSER Converted from Clipper to C. 03/07/90 GARRY PREFONTAINE For use in SuperFunction Lib Found in: wildcard.c ----------------------------------------------------------------- FUNCTION::XBXX() Draw a box on the screen with attribute and XBXX() Purpose : Draw a box on the screen with attribute and optional shadow Usage: Bxx(<expN1>, <expN2>, <expN3>, <expN4>, <expN5>, <expN6> ,<expN7>, <expC>,<expn8>) Params : expN1 - top row expN2 - left col expN3 - bottom row expN4 - right column expN5 - attribute of box expN6 - numeric shadow type (default 0) follow numeric keypad 7 = upper left 1 = lower left 3 = lower right 9 = upper right 0 = no shadow expN7 - shadow attribute (default 7 - grey on black) expC - frame string - MUST be 8 characters - default single expN8 - explode speed factor 1-1000 (depends on machine) All params MUST be passed. For numerics,pass -1 for default. For string, pass '' for default. Returns : nothing. Found in: xbxx.c